Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update samples for v4 #223

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Update samples for v4 #223

merged 2 commits into from
Dec 12, 2024

Conversation

zkamvar
Copy link
Member

@zkamvar zkamvar commented Dec 12, 2024

Note that this does not fix #169, but it addresses the is_required element for v4 along with minor improvements:

  • smart quotes are replaced with ASCII
  • tabs are replace with spaces
  • JSON examples are aligned properly and the relevant lines highlighted
  • HTML table is given appropriate headers for accessibility (instead of all cells being equivalent)

Preview: https://hubdocs--223.org.readthedocs.build/en/223/user-guide/sample-output-type.html

fix for v4:

 - output_type_id_params no longer has the is_required property

tidying:

 - smart quotes are replaced with ASCII
 - tabs are replace with spaces
 - JSON examples are aligned properly and the relevant lines highlighted
This gives the table clear column and row headers, so that it is
accessible by a screen reader (and easier to visually parse)
@zkamvar zkamvar merged commit 16412ac into main Dec 12, 2024
1 check passed
@zkamvar zkamvar deleted the znk/update-samples branch December 12, 2024 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

sample-output-type.md: Clarifying questions and editing suggestions
2 participants